<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>XfceScreensaver: libxfce4ui Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libxfce4ui Reference Manual">
<link rel="up" href="libxfce4ui-sm.html" title="Part V. Xfce Session Management Support">
<link rel="prev" href="XfceSMClient.html" title="XfceSMClient">
<link rel="next" href="api-index-full.html" title="Index of all symbols">
<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#XfceScreensaver.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#XfceScreensaver.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
                  <a href="#XfceScreensaver.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="libxfce4ui-sm.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="XfceSMClient.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="api-index-full.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="XfceScreensaver"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="XfceScreensaver.top_of_page"></a>XfceScreensaver</span></h2>
<p>XfceScreensaver — screensaver related shared functions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="XfceScreensaver.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="returnvalue">XfceScreensaver</span></a> *
</td>
<td class="function_name">
<a class="link" href="XfceScreensaver.html#xfce-screensaver-new" title="xfce_screensaver_new ()">xfce_screensaver_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="XfceScreensaver.html#xfce-screensaver-inhibit" title="xfce_screensaver_inhibit ()">xfce_screensaver_inhibit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="XfceScreensaver.html#xfce-screensaver-lock" title="xfce_screensaver_lock ()">xfce_screensaver_lock</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceScreensaver.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<span class="type">char</span> *</td>
<td class="property_name"><a class="link" href="XfceScreensaver.html#XfceScreensaver--heartbeat-command" title="The “heartbeat-command” property">heartbeat-command</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type">
<span class="type">char</span> *</td>
<td class="property_name"><a class="link" href="XfceScreensaver.html#XfceScreensaver--lock-command" title="The “lock-command” property">lock-command</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="XfceScreensaver.html#XfceScreensaver--lock-on-sleep" title="The “lock-on-sleep” property">lock-on-sleep</a></td>
<td class="property_flags">Read / Write / Construct</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceScreensaver.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="other_proto_type">
<col class="other_proto_name">
</colgroup>
<tbody><tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="XfceScreensaver.html#XfceScreensaver-struct" title="XfceScreensaver">XfceScreensaver</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="XfceScreensaver.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
    <span class="lineart">╰──</span> XfceScreensaver
</pre>
</div>
<div class="refsect1">
<a name="XfceScreensaver.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libxfce4ui/libxfce4ui.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="XfceScreensaver.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="XfceScreensaver.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="xfce-screensaver-new"></a><h3>xfce_screensaver_new ()</h3>
<pre class="programlisting"><a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="returnvalue">XfceScreensaver</span></a> *
xfce_screensaver_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object or increases the reference count
of the current object.</p>
<div class="refsect3">
<a name="xfce-screensaver-new.returns"></a><h4>Returns</h4>
<p>An <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object, to be released with
<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when no longer used. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-18.html#api-index-4.18.2">4.18.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screensaver-inhibit"></a><h3>xfce_screensaver_inhibit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
xfce_screensaver_inhibit (<em class="parameter"><code><a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> *saver</code></em>,
                          <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> inhibit</code></em>);</pre>
<p>Calling this function with <em class="parameter"><code>inhibit</code></em>
 as <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> will prevent the user's
screensaver from activating. This is useful when the user is watching
a movie or giving a presentation.</p>
<p>Calling this function with <em class="parameter"><code>inhibit</code></em>
 as <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> will remove any current
screensaver inhibit the <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object has.</p>
<div class="refsect3">
<a name="xfce-screensaver-inhibit.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>saver</p></td>
<td class="parameter_description"><p>the <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>inhibit</p></td>
<td class="parameter_description"><p>whether to inhibit the screensaver from activating</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-4-18.html#api-index-4.18.2">4.18.2</a></p>
</div>
<hr>
<div class="refsect2">
<a name="xfce-screensaver-lock"></a><h3>xfce_screensaver_lock ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
xfce_screensaver_lock (<em class="parameter"><code><a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> *saver</code></em>);</pre>
<p>Attempts to lock the screen, either with one of the screensaver
D-Bus proxies, the Xfconf lock command, or one of the
fallback scripts such as xdg-screensaver.</p>
<div class="refsect3">
<a name="xfce-screensaver-lock.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>saver</p></td>
<td class="parameter_description"><p>the <a class="link" href="XfceScreensaver.html" title="XfceScreensaver"><span class="type">XfceScreensaver</span></a> object</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="xfce-screensaver-lock.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the lock attempt returns success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-4-18.html#api-index-4.18.2">4.18.2</a></p>
</div>
</div>
<div class="refsect1">
<a name="XfceScreensaver.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="XfceScreensaver-struct"></a><h3>XfceScreensaver</h3>
<pre class="programlisting">typedef struct _XfceScreensaver XfceScreensaver;</pre>
</div>
</div>
<div class="refsect1">
<a name="XfceScreensaver.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="XfceScreensaver--heartbeat-command"></a><h3>The <code class="literal">“heartbeat-command”</code> property</h3>
<pre class="programlisting">  “heartbeat-command”        <span class="type">char</span> *</pre>
<p>Inhibit the screensaver from activating, e.g. xscreensaver-command --deactivate.</p>
<p>Owner: XfceScreensaver</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="XfceScreensaver--lock-command"></a><h3>The <code class="literal">“lock-command”</code> property</h3>
<pre class="programlisting">  “lock-command”             <span class="type">char</span> *</pre>
<p>Lock the desktop, e.g. xscreensaver-command --lock.</p>
<p>Owner: XfceScreensaver</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="XfceScreensaver--lock-on-sleep"></a><h3>The <code class="literal">“lock-on-sleep”</code> property</h3>
<pre class="programlisting">  “lock-on-sleep”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>Whether to lock before suspend/hibernate.</p>
<p>Owner: XfceScreensaver</p>
<p>Flags: Read / Write / Construct</p>
<p>Default value: FALSE</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.33.1</div>
</body>
</html>